www.gusucode.com > Piwik 网站流量统计系统 v2.9.1PHP源码程序 > Piwik 网站流量统计系统 v2.9.1/piwik/piwik/core/Date.php
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Exception;
/**
* Utility class that wraps date/time related PHP functions. Using this class can
* be easier than using `date`, `time`, `date_default_timezone_set`, etc.
*
* ### Performance concerns
*
* The helper methods in this class are instance methods and thus `Date` instances
* need to be constructed before they can be used. The memory allocation can result
* in noticeable performance degradation if you construct thousands of Date instances,
* say, in a loop.
*
* ### Examples
*
* **Basic usage**
*
* $date = Date::factory('2007-07-24 14:04:24', 'EST');
* $date->addHour(5);
* echo $date->getLocalized("%longDay% the %day% of %longMonth% at %time%");
*
* @api
*/
class Date
{
/** Number of seconds in a day. */
const NUM_SECONDS_IN_DAY = 86400;
/** The default date time string format. */
const DATE_TIME_FORMAT = 'Y-m-d H:i:s';
/**
* Max days for months (non-leap-year). See {@link addPeriod()} implementation.
*
* @var int[]
*/
private static $maxDaysInMonth = array(
'1' => 31,
'2' => 28,
'3' => 31,
'4' => 30,
'5' => 31,
'6' => 30,
'7' => 31,
'8' => 31,
'9' => 30,
'10' => 31,
'11' => 30,
'12' => 31
);
/**
* The stored timestamp is always UTC based.
* The returned timestamp via getTimestamp() will have the conversion applied
* @var int|null
*/
protected $timestamp = null;
/**
* Timezone the current date object is set to.
* Timezone will only affect the returned timestamp via getTimestamp()
* @var string
*/
protected $timezone = 'UTC';
/**
* Constructor.
*
* @param int $timestamp The number in seconds since the unix epoch.
* @param string $timezone The timezone of the datetime.
* @throws Exception If $timestamp is not an int.
*/
protected function __construct($timestamp, $timezone = 'UTC')
{
if (!is_int($timestamp)) {
throw new Exception("Date is expecting a unix timestamp, got: '$timestamp'.");
}
$this->timezone = $timezone;
$this->timestamp = $timestamp;
}
/**
* Creates a new Date instance using a string datetime value. The timezone of the Date
* result will be in UTC.
*
* @param string|int $dateString `'today'`, `'yesterday'`, `'now'`, `'yesterdaySameTime'`, a string with
* `'YYYY-MM-DD HH:MM:SS'` format or a unix timestamp.
* @param string $timezone The timezone of the result. If specified, `$dateString` will be converted
* from UTC to this timezone before being used in the Date return value.
* @throws Exception If `$dateString` is in an invalid format or if the time is before
* Tue, 06 Aug 1991.
* @return Date
*/
public static function factory($dateString, $timezone = null)
{
$invalidDateException = new Exception(Piwik::translate('General_ExceptionInvalidDateFormat', array("YYYY-MM-DD, or 'today' or 'yesterday'", "strtotime", "http://php.net/strtotime")) . ": $dateString");
if ($dateString instanceof self) {
$dateString = $dateString->toString();
}
if ($dateString == 'now') {
$date = self::now();
} elseif ($dateString == 'today') {
$date = self::today();
} elseif ($dateString == 'yesterday') {
$date = self::yesterday();
} elseif ($dateString == 'yesterdaySameTime') {
$date = self::yesterdaySameTime();
} elseif (!is_int($dateString)
&& (
// strtotime returns the timestamp for April 1st for a date like 2011-04-01,today
// but we don't want this, as this is a date range and supposed to throw the exception
strpos($dateString, ',') !== false
||
($dateString = strtotime($dateString)) === false
)
) {
throw $invalidDateException;
} else {
$date = new Date($dateString);
}
$timestamp = $date->getTimestamp();
// can't be doing web analytics before the 1st website
// Tue, 06 Aug 1991 00:00:00 GMT
if ($timestamp < 681436800) {
throw $invalidDateException;
}
if (empty($timezone)) {
return $date;
}
$timestamp = self::adjustForTimezone($timestamp, $timezone);
return Date::factory($timestamp);
}
/**
* Returns the current timestamp as a string with the following format: `'YYYY-MM-DD HH:MM:SS'`.
*
* @return string
*/
public function getDatetime()
{
return $this->toString(self::DATE_TIME_FORMAT);
}
/**
* Returns the start of the day of the current timestamp in UTC. For example,
* if the current timestamp is `'2007-07-24 14:04:24'` in UTC, the result will
* be `'2007-07-24'`.
*
* @return string
*/
public function getDateStartUTC()
{
$dateStartUTC = gmdate('Y-m-d', $this->timestamp);
$date = Date::factory($dateStartUTC)->setTimezone($this->timezone);
return $date->toString(self::DATE_TIME_FORMAT);
}
/**
* Returns the end of the day of the current timestamp in UTC. For example,
* if the current timestamp is `'2007-07-24 14:03:24'` in UTC, the result will
* be `'2007-07-24 23:59:59'`.
*
* @return string
*/
public function getDateEndUTC()
{
$dateEndUTC = gmdate('Y-m-d 23:59:59', $this->timestamp);
$date = Date::factory($dateEndUTC)->setTimezone($this->timezone);
return $date->toString(self::DATE_TIME_FORMAT);
}
/**
* Returns a new date object with the same timestamp as `$this` but with a new
* timezone.
*
* See {@link getTimestamp()} to see how the timezone is used.
*
* @param string $timezone eg, `'UTC'`, `'Europe/London'`, etc.
* @return Date
*/
public function setTimezone($timezone)
{
return new Date($this->timestamp, $timezone);
}
/**
* Helper function that returns the offset in the timezone string 'UTC+14'
* Returns false if the timezone is not UTC+X or UTC-X
*
* @param string $timezone
* @return int|bool utc offset or false
*/
protected static function extractUtcOffset($timezone)
{
if ($timezone == 'UTC') {
return 0;
}
$start = substr($timezone, 0, 4);
if ($start != 'UTC-'
&& $start != 'UTC+'
) {
return false;
}
$offset = (float)substr($timezone, 4);
if ($start == 'UTC-') {
$offset = -$offset;
}
return $offset;
}
/**
* Converts a timestamp in a from UTC to a timezone.
*
* @param int $timestamp The UNIX timestamp to adjust.
* @param string $timezone The timezone to adjust to.
* @return int The adjusted time as seconds from EPOCH.
*/
public static function adjustForTimezone($timestamp, $timezone)
{
// manually adjust for UTC timezones
$utcOffset = self::extractUtcOffset($timezone);
if ($utcOffset !== false) {
return self::addHourTo($timestamp, $utcOffset);
}
date_default_timezone_set($timezone);
$datetime = date(self::DATE_TIME_FORMAT, $timestamp);
date_default_timezone_set('UTC');
return strtotime($datetime);
}
/**
* Returns the Unix timestamp of the date in UTC.
*
* @return int
*/
public function getTimestampUTC()
{
return $this->timestamp;
}
/**
* Returns the unix timestamp of the date in UTC, converted from the current
* timestamp timezone.
*
* @return int
*/
public function getTimestamp()
{
if (empty($this->timezone)) {
$this->timezone = 'UTC';
}
$utcOffset = self::extractUtcOffset($this->timezone);
if ($utcOffset !== false) {
return (int)($this->timestamp - $utcOffset * 3600);
}
// The following code seems clunky - I thought the DateTime php class would allow to return timestamps
// after applying the timezone offset. Instead, the underlying timestamp is not changed.
// I decided to get the date without the timezone information, and create the timestamp from the truncated string.
// Unit tests pass (@see Date.test.php) but I'm pretty sure this is not the right way to do it
date_default_timezone_set($this->timezone);
$dtzone = timezone_open('UTC');
$time = date('r', $this->timestamp);
$dtime = date_create($time);
date_timezone_set($dtime, $dtzone);
$dateWithTimezone = date_format($dtime, 'r');
$dateWithoutTimezone = substr($dateWithTimezone, 0, -6);
$timestamp = strtotime($dateWithoutTimezone);
date_default_timezone_set('UTC');
return (int) $timestamp;
}
/**
* Returns `true` if the current date is older than the given `$date`.
*
* @param Date $date
* @return bool
*/
public function isLater(Date $date)
{
return $this->getTimestamp() > $date->getTimestamp();
}
/**
* Returns `true` if the current date is earlier than the given `$date`.
*
* @param Date $date
* @return bool
*/
public function isEarlier(Date $date)
{
return $this->getTimestamp() < $date->getTimestamp();
}
/**
* Returns `true` if the current year is a leap year, false otherwise.
*
* @return bool
*/
public function isLeapYear()
{
$currentYear = date('Y', $this->getTimestamp());
return ($currentYear % 400) == 0 || (($currentYear % 4) == 0 && ($currentYear % 100) != 0);
}
/**
* Converts this date to the requested string format. See {@link http://php.net/date}
* for the list of format strings.
*
* @param string $format
* @return string
*/
public function toString($format = 'Y-m-d')
{
return date($format, $this->getTimestamp());
}
/**
* See {@link toString()}.
*
* @return string The current date in `'YYYY-MM-DD'` format.
*/
public function __toString()
{
return $this->toString();
}
/**
* Performs three-way comparison of the week of the current date against the given `$date`'s week.
*
* @param \Piwik\Date $date
* @return int Returns `0` if the current week is equal to `$date`'s, `-1` if the current week is
* earlier or `1` if the current week is later.
*/
public function compareWeek(Date $date)
{
$currentWeek = date('W', $this->getTimestamp());
$toCompareWeek = date('W', $date->getTimestamp());
if ($currentWeek == $toCompareWeek) {
return 0;
}
if ($currentWeek < $toCompareWeek) {
return -1;
}
return 1;
}
/**
* Performs three-way comparison of the month of the current date against the given `$date`'s month.
*
* @param \Piwik\Date $date Month to compare
* @return int Returns `0` if the current month is equal to `$date`'s, `-1` if the current month is
* earlier or `1` if the current month is later.
*/
public function compareMonth(Date $date)
{
$currentMonth = date('n', $this->getTimestamp());
$toCompareMonth = date('n', $date->getTimestamp());
if ($currentMonth == $toCompareMonth) {
return 0;
}
if ($currentMonth < $toCompareMonth) {
return -1;
}
return 1;
}
/**
* Performs three-way comparison of the month of the current date against the given `$date`'s year.
*
* @param \Piwik\Date $date Year to compare
* @return int Returns `0` if the current year is equal to `$date`'s, `-1` if the current year is
* earlier or `1` if the current year is later.
*/
public function compareYear(Date $date)
{
$currentYear = date('Y', $this->getTimestamp());
$toCompareYear = date('Y', $date->getTimestamp());
if ($currentYear == $toCompareYear) {
return 0;
}
if ($currentYear < $toCompareYear) {
return -1;
}
return 1;
}
/**
* Returns `true` if current date is today.
*
* @return bool
*/
public function isToday()
{
return $this->toString('Y-m-d') === Date::factory('today', $this->timezone)->toString('Y-m-d');
}
/**
* Returns a date object set to now in UTC (same as {@link today()}, except that the time is also set).
*
* @return \Piwik\Date
*/
public static function now()
{
return new Date(time());
}
/**
* Returns a date object set to today at midnight in UTC.
*
* @return \Piwik\Date
*/
public static function today()
{
return new Date(strtotime(date("Y-m-d 00:00:00")));
}
/**
* Returns a date object set to yesterday at midnight in UTC.
*
* @return \Piwik\Date
*/
public static function yesterday()
{
return new Date(strtotime("yesterday"));
}
/**
* Returns a date object set to yesterday with the current time of day in UTC.
*
* @return \Piwik\Date
*/
public static function yesterdaySameTime()
{
return new Date(strtotime("yesterday " . date('H:i:s')));
}
/**
* Returns a new Date instance with `$this` date's day and the specified new
* time of day.
*
* @param string $time String in the `'HH:MM:SS'` format.
* @return \Piwik\Date The new date with the time of day changed.
*/
public function setTime($time)
{
return new Date(strtotime(date("Y-m-d", $this->timestamp) . " $time"), $this->timezone);
}
/**
* Returns a new Date instance with `$this` date's time of day and the day specified
* by `$day`.
*
* @param int $day The day eg. `31`.
* @return \Piwik\Date
*/
public function setDay($day)
{
$ts = $this->timestamp;
$result = mktime(
date('H', $ts),
date('i', $ts),
date('s', $ts),
date('n', $ts),
$day,
date('Y', $ts)
);
return new Date($result, $this->timezone);
}
/**
* Returns a new Date instance with `$this` date's time of day, month and day, but with
* a new year (specified by `$year`).
*
* @param int $year The year, eg. `2010`.
* @return \Piwik\Date
*/
public function setYear($year)
{
$ts = $this->timestamp;
$result = mktime(
date('H', $ts),
date('i', $ts),
date('s', $ts),
date('n', $ts),
date('j', $ts),
$year
);
return new Date($result, $this->timezone);
}
/**
* Subtracts `$n` number of days from `$this` date and returns a new Date object.
*
* @param int $n An integer > 0.
* @return \Piwik\Date
*/
public function subDay($n)
{
if ($n === 0) {
return clone $this;
}
$ts = strtotime("-$n day", $this->timestamp);
return new Date($ts, $this->timezone);
}
/**
* Subtracts `$n` weeks from `$this` date and returns a new Date object.
*
* @param int $n An integer > 0.
* @return \Piwik\Date
*/
public function subWeek($n)
{
return $this->subDay(7 * $n);
}
/**
* Subtracts `$n` months from `$this` date and returns the result as a new Date object.
*
* @param int $n An integer > 0.
* @return \Piwik\Date new date
*/
public function subMonth($n)
{
if ($n === 0) {
return clone $this;
}
$ts = $this->timestamp;
$result = mktime(
date('H', $ts),
date('i', $ts),
date('s', $ts),
date('n', $ts) - $n,
1, // we set the day to 1
date('Y', $ts)
);
return new Date($result, $this->timezone);
}
/**
* Subtracts `$n` years from `$this` date and returns the result as a new Date object.
*
* @param int $n An integer > 0.
* @return \Piwik\Date
*/
public function subYear($n)
{
if ($n === 0) {
return clone $this;
}
$ts = $this->timestamp;
$result = mktime(
date('H', $ts),
date('i', $ts),
date('s', $ts),
1, // we set the month to 1
1, // we set the day to 1
date('Y', $ts) - $n
);
return new Date($result, $this->timezone);
}
/**
* Returns a localized date string using the given template.
* The template should contain tags that will be replaced with localized date strings.
*
* Allowed tags include:
*
* - **%day%**: replaced with the day of the month without leading zeros, eg, **1** or **20**.
* - **%shortMonth%**: the short month in the current language, eg, **Jan**, **Feb**.
* - **%longMonth%**: the whole month name in the current language, eg, **January**, **February**.
* - **%shortDay%**: the short day name in the current language, eg, **Mon**, **Tue**.
* - **%longDay%**: the long day name in the current language, eg, **Monday**, **Tuesday**.
* - **%longYear%**: the four digit year, eg, **2007**, **2013**.
* - **%shortYear%**: the two digit year, eg, **07**, **13**.
* - **%time%**: the time of day, eg, **07:35:00**, or **15:45:00**.
*
* @param string $template eg. `"%shortMonth% %longYear%"`
* @return string eg. `"Aug 2009"`
*/
public function getLocalized($template)
{
$day = $this->toString('j');
$dayOfWeek = $this->toString('N');
$monthOfYear = $this->toString('n');
$patternToValue = array(
"%day%" => $day,
"%shortMonth%" => Piwik::translate('General_ShortMonth_' . $monthOfYear),
"%longMonth%" => Piwik::translate('General_LongMonth_' . $monthOfYear),
"%shortDay%" => Piwik::translate('General_ShortDay_' . $dayOfWeek),
"%longDay%" => Piwik::translate('General_LongDay_' . $dayOfWeek),
"%longYear%" => $this->toString('Y'),
"%shortYear%" => $this->toString('y'),
"%time%" => $this->toString('H:i:s')
);
$out = str_replace(array_keys($patternToValue), array_values($patternToValue), $template);
return $out;
}
/**
* Adds `$n` days to `$this` date and returns the result in a new Date.
* instance.
*
* @param int $n Number of days to add, must be > 0.
* @return \Piwik\Date
*/
public function addDay($n)
{
$ts = strtotime("+$n day", $this->timestamp);
return new Date($ts, $this->timezone);
}
/**
* Adds `$n` hours to `$this` date and returns the result in a new Date.
*
* @param int $n Number of hours to add. Can be less than 0.
* @return \Piwik\Date
*/
public function addHour($n)
{
$ts = self::addHourTo($this->timestamp, $n);
return new Date($ts, $this->timezone);
}
/**
* Adds N number of hours to a UNIX timestamp and returns the result. Using
* this static function instead of {@link addHour()} will be faster since a
* Date instance does not have to be created.
*
* @param int $timestamp The timestamp to add to.
* @param number $n Number of hours to add, must be > 0.
* @return int The result as a UNIX timestamp.
*/
public static function addHourTo($timestamp, $n)
{
$isNegative = ($n < 0);
$minutes = 0;
if ($n != round($n)) {
if ($n >= 1 || $n <= -1) {
$extraMinutes = floor(abs($n));
if ($isNegative) {
$extraMinutes = -$extraMinutes;
}
$minutes = abs($n - $extraMinutes) * 60;
if ($isNegative) {
$minutes *= -1;
}
} else {
$minutes = $n * 60;
}
$n = floor(abs($n));
if ($isNegative) {
$n *= -1;
}
}
return (int)($timestamp + round($minutes * 60) + $n * 3600);
}
/**
* Subtracts `$n` hours from `$this` date and returns the result in a new Date.
*
* @param int $n Number of hours to subtract. Can be less than 0.
* @return \Piwik\Date
*/
public function subHour($n)
{
return $this->addHour(-$n);
}
/**
* Adds a period to `$this` date and returns the result in a new Date instance.
*
* @param int $n The number of periods to add. Can be negative.
* @param string $period The type of period to add (YEAR, MONTH, WEEK, DAY, ...)
* @return \Piwik\Date
*/
public function addPeriod($n, $period)
{
if (strtolower($period) == 'month') { // TODO: comments
$dateInfo = getdate($this->timestamp);
$ts = mktime(
$dateInfo['hours'],
$dateInfo['minutes'],
$dateInfo['seconds'],
$dateInfo['mon'] + (int)$n,
1,
$dateInfo['year']
);
$daysToAdd = min($dateInfo['mday'], self::getMaxDaysInMonth($ts)) - 1;
$ts += self::NUM_SECONDS_IN_DAY * $daysToAdd;
} else {
$time = $n < 0 ? "$n $period" : "+$n $period";
$ts = strtotime($time, $this->timestamp);
}
return new Date($ts, $this->timezone);
}
private static function getMaxDaysInMonth($timestamp)
{
$month = (int)date('m', $timestamp);
if (date('L', $timestamp) == 1
&& $month == 2
) {
return 29;
} else {
return self::$maxDaysInMonth[$month];
}
}
/**
* Subtracts a period from `$this` date and returns the result in a new Date instance.
*
* @param int $n The number of periods to add. Can be negative.
* @param string $period The type of period to add (YEAR, MONTH, WEEK, DAY, ...)
* @return \Piwik\Date
*/
public function subPeriod($n, $period)
{
return $this->addPeriod(-$n, $period);
}
/**
* Returns the number of days represented by a number of seconds.
*
* @param int $secs
* @return float
*/
public static function secondsToDays($secs)
{
return $secs / self::NUM_SECONDS_IN_DAY;
}
}